lteiot23.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef LTEIOT23_H
#define LTEIOT23_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"




#define LTEIOT23_CMD_AT                                 "AT"
#define LTEIOT23_CMD_GET_MODEL_ID                       "AT+CGMM"
#define LTEIOT23_CMD_GET_SW_VERSION                     "AT+CGMR"
#define LTEIOT23_CMD_GET_SERIAL_NUM                     "AT+CGSN"
#define LTEIOT23_CMD_FACTORY_RESET                      "AT&F0"
#define LTEIOT23_CMD_SW_RESET                           "ATZ"
#define LTEIOT23_CMD_SET_UE_FUNCTIONALITY               "AT+CFUN"
#define LTEIOT23_CMD_NETWORK_REGISTRATION               "AT+CEREG"
#define LTEIOT23_CMD_SIGNAL_QUALITY_REPORT              "AT%CSQ"
#define LTEIOT23_CMD_OPERATOR_SELECTION                 "AT+COPS"
#define LTEIOT23_CMD_SEND_SMS                           "AT+CMGS"
#define LTEIOT23_CMD_SELECT_SMS_FORMAT                  "AT+CMGF"
#define LTEIOT23_CMD_DEFINE_PDP_CONTEXT                 "AT+CGDCONT"
#define LTEIOT23_CMD_SHOW_PDP_ADDRESS                   "AT+CGPADDR"
#define LTEIOT23_CMD_ACTIVATE_PDP_CONTEXT               "AT+CGACT"
#define LTEIOT23_CMD_SOCKET_CMD                         "AT%SOCKETCMD"
#define LTEIOT23_CMD_SOCKET_DATA                        "AT%SOCKETDATA"
#define LTEIOT23_CMD_SOCKET_EVENTS                      "AT%SOCKETEV"

#define LTEIOT23_RSP_OK                                 "OK"
#define LTEIOT23_RSP_ERROR                              "ERROR"

#define LTEIOT23_MAX_RSP_TIME_DEFAULT                   500ul
#define LTEIOT23_MAX_RSP_TIME_COPS                      180000ul
#define LTEIOT23_MAX_RSP_TIME_CFUN                      15000ul
#define LTEIOT23_MAX_RSP_TIME_CMGS                      120000ul
#define LTEIOT23_MAX_RSP_TIME_CGDCONT                   5000ul
#define LTEIOT23_MAX_RSP_TIME_URC                       30000ul

#define LTEIOT23_URC_SOCKET_DATA_EVENT                  "%SOCKETEV:"
#define LTEIOT23_URC_SOCKET_DATA                        "%SOCKETDATA:"
#define LTEIOT23_URC_NETWORK_REGISTERED                 "+CEREG: 2,1"
#define LTEIOT23_URC_SMS_FORMAT_PDU                     "+CMGF: 0"
#define LTEIOT23_URC_SMS_FORMAT_TXT                     "+CMGF: 1"
#define LTEIOT23_URC_BOOT_EVENT                         "%BOOTEV:"

#define LTEIOT23_POWER_STATE_OFF                        0
#define LTEIOT23_POWER_STATE_ON                         1

#define LTEIOT23_TX_DRV_BUFFER_SIZE                     256
#define LTEIOT23_RX_DRV_BUFFER_SIZE                     256
 // lteiot23_cmd



#define LTEIOT23_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.hwu = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.wup = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 // lteiot23_map // lteiot23

typedef struct
{
    // Output pins
    digital_out_t rst;                  
    digital_out_t cts;                  
    digital_out_t wup;                  
 
    // Input pins
    digital_in_t hwu;                   
    digital_in_t rts;                   
 
    // Modules
    uart_t uart;                        
 
    // Buffers
    uint8_t uart_rx_buffer[ LTEIOT23_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ LTEIOT23_TX_DRV_BUFFER_SIZE ];  
    uint8_t cmd_buffer[ LTEIOT23_TX_DRV_BUFFER_SIZE ];      
 
} lteiot23_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                  
    pin_name_t tx_pin;                  
 
    // Additional gpio pins
    pin_name_t hwu;                     
    pin_name_t rst;                     
    pin_name_t cts;                     
    pin_name_t wup;                     
    pin_name_t rts;                     
 
    // Static variable
    uint32_t         baud_rate;         
    bool             uart_blocking;     
    uart_data_bits_t data_bit;          
    uart_parity_t    parity_bit;        
    uart_stop_bits_t stop_bit;          
 
} lteiot23_cfg_t;

typedef enum
{
    LTEIOT23_OK = 0,
    LTEIOT23_ERROR = -1,
    LTEIOT23_ERROR_TIMEOUT = -2,
    LTEIOT23_ERROR_CMD = -3
 
} lteiot23_return_value_t;


void lteiot23_cfg_setup ( lteiot23_cfg_t *cfg );

err_t lteiot23_init ( lteiot23_t *ctx, lteiot23_cfg_t *cfg );

err_t lteiot23_generic_write ( lteiot23_t *ctx, uint8_t *data_in, uint16_t len );

err_t lteiot23_generic_read ( lteiot23_t *ctx, uint8_t *data_out, uint16_t len );

void lteiot23_set_wup_pin ( lteiot23_t *ctx, uint8_t state );

void lteiot23_set_rst_pin ( lteiot23_t *ctx, uint8_t state );

void lteiot23_set_cts_pin ( lteiot23_t *ctx, uint8_t state );

uint8_t lteiot23_get_hwu_pin ( lteiot23_t *ctx );

uint8_t lteiot23_get_rts_pin ( lteiot23_t *ctx );

void lteiot23_set_power_state ( lteiot23_t *ctx, uint8_t state );

void lteiot23_cmd_run ( lteiot23_t *ctx, uint8_t *cmd );

void lteiot23_cmd_set ( lteiot23_t *ctx, uint8_t *cmd, uint8_t *value );

void lteiot23_cmd_get ( lteiot23_t *ctx, uint8_t *cmd );

void lteiot23_cmd_help ( lteiot23_t *ctx, uint8_t *cmd );

void lteiot23_set_sim_apn ( lteiot23_t *ctx, uint8_t *sim_apn );

void lteiot23_send_sms_text ( lteiot23_t *ctx, uint8_t *phone_number, uint8_t *sms_text );

err_t lteiot23_send_sms_pdu ( lteiot23_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif // LTEIOT23_H
 // lteiot23
 
// ------------------------------------------------------------------------ END